Amazonpay API一覧 | マルペイDocs

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranAmazonpay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須半角英字7桁処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
AmazonpayType	amazonpayType	必須半角数字1桁 AmazonPay実装タイプ「1」を設定してください。

URL

/payment/EntryTranAmazonpay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "xxxxxxxx",
    "orderID": "ORDER0000001",
    "jobCd": "AUTH",
    "amount": "1000",
    "amazonpayType": "1"
}

URL

/payment/EntryTranAmazonpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=xxxxxxxx&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000&AmazonpayType=1

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranAmazonpay 決済実行

取引登録した決済に対して仮売上を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
AmazonOrderReferenceID	amazonOrderReferenceID	必須半角英数19桁 AmazonオーダーリファレンスID 加盟店様サイトでウィジェットを表示した際に取得できるAmazonOrderReferenceIDを設定します。ポイント弊社「テスト環境」では正当性チェックを行っていないため、ダミー値でも決済可能です。 ※ただし、AmazonのSANDBOX環境をご利用の場合、正当性チェックが行われます。

URL

/payment/ExecTranAmazonpay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "amazonOrderReferenceID": "S03-0199932-5250784"
}

URL

/payment/ExecTranAmazonpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&AmazonOrderReferenceID=S03-0199932-5250784

レスポンス

正常

ShopID	shopID	必須半角英数13桁ショップID
OrderID	orderID	必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status	status	必須現状態 AUTH：仮売上 REQCAPTURE：即時売上要求 CAPTURE：即時売上
TranDate	tranDate	必須半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
AmazonOrderReferenceID	amazonOrderReferenceID	必須半角英数19桁 AmazonオーダーリファレンスID Amazonで取引を特定するためのIDを返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "shopID": "tshop11223344",
    "orderID": "ORDER0000001",
    "status": "AUTH",
    "tranDate": "20190225162711",
    "amazonOrderReferenceID": "S03-0199932-5250784"
}

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20190225162711&AmazonOrderReferenceID=S03-0199932-5250784

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AmazonpaySales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、利用金額 + 税送料が売上金額となります。仮売上時の金額と一致しない場合エラーとなります。
Tax	tax	半角数字7桁税送料税送料を指定した場合は、利用金額 + 税送料が売上金額となります。仮売上時の金額と一致しない場合エラーとなります。

URL

/payment/AmazonpaySales.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "amount": "1000"
}

URL

/payment/AmazonpaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status	status	必須現状態 REQSALES：売上受付 SALES：実売上
Amount	amount	必須半角数字7桁利用金額実売上した利用金額を返却します。
Tax	tax	必須半角数字7桁税送料実売上したを税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AmazonpayCancel キャンセル

対象の取引をキャンセルします。尚、確定後の取引については減額が可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額キャンセル金額 + キャンセル税送料が処理金額となります。対象取引が仮売上の場合、キャンセル金額・税送料は仮売上時の金額を指定してください。対象取引が実売上または即時売上状態の場合、[1円～現在の金額]の範囲で指定が可能です。
CancelTax	cancelTax	半角数字7桁キャンセル税送料キャンセル金額 + キャンセル税送料が処理金額となります。対象取引が仮売上の場合、キャンセル金額・税送料は仮売上時の金額を指定してください。対象取引が実売上または即時売上状態の場合、[1円～現在の金額]の範囲で指定が可能です。

URL

/payment/AmazonpayCancel.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "cancelAmount": "1000"
}

URL

/payment/AmazonpayCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status	status	必須現状態対象取引の取引状態を返却します。対象取引が仮売上状態だった場合・CANCEL：キャンセル対象取引が実売上または即時売上状態だった場合・REQRETURN：返品受付・RETURN：返品全額キャンセルでない場合はキャンセル処理前のステータスが返却されます。
Amount	amount	必須半角数字7桁利用金額利用金額からキャンセル金額を減算した結果を返却します。
Tax	tax	必須半角数字7桁税送料税送料からキャンセル税送料を減算した結果を返却します。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額キャンセル金額を返却します。
CancelTax	cancelTax	必須半角数字7桁キャンセル税送料キャンセル税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "CANCEL",
    "amount": "0",
    "tax": "0",
    "cancelAmount": "1000",
    "cancelTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchAddressAmazonpay 住所情報参照

対象取引に対する住所情報を取得します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。 ※決済完了後のオーダーIDのみ有効です。

URL

/payment/SearchAddressAmazonpay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "xxxxxxxx",
    "orderID": "ORDER0000001"
}

URL

/payment/SearchAddressAmazonpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=xxxxxxxx&OrderID=ORDER0000001

レスポンス

正常

ShippingCountryCode	shippingCountryCode	必須配送先国コード決済時にウィジェットで選択した住所の国コードを返却します。住所ウィジェットを選択していない場合は空を返却します。例：JP
ShippingPostalCode	shippingPostalCode	必須配送先郵便番号決済時にウィジェットで選択した住所の郵便番号を返却します。住所ウィジェットを選択していない場合は空を返却します。例：150-0043
ShippingStateOrRegion	shippingStateOrRegion	必須配送先都道府県決済時にウィジェットで選択した住所の都道府県を返却します。住所ウィジェットを選択していない場合は空を返却します。例：東京都
ShippingAddressLine1	shippingAddressLine1	必須配送先住所1 決済時にウィジェットで選択した住所を返却します。住所ウィジェットを選択していない場合は空を返却します。例：渋谷区道玄坂 3-14-6
ShippingAddressLine2	shippingAddressLine2	必須配送先住所2 決済時にウィジェットで選択した住所を返却します。住所ウィジェットを選択していない場合は空を返却します。例：渋谷ビルディング
ShippingAddressLine3	shippingAddressLine3	必須配送先住所3 決済時にウィジェットで選択した住所の会社名を返却します。住所ウィジェットを選択していない場合は空を返却します。例：○○株式会社
ShippingName	shippingName	必須配送先氏名決済時にウィジェットで選択した住所の氏名を返却します。住所ウィジェットを選択していない場合は空を返却します。例：テスト花子
ShippingPhoneNumber	shippingPhoneNumber	必須配送先電話番号決済時にウィジェットで選択した住所の電話番号を返却します。住所ウィジェットを選択していない場合は空を返却します。例：03-0000-0001
AmazonAccountName	amazonAccountName	必須 Amazonアカウント名 Amazonアカウントの氏名を返却します。例：テスト太郎
AmazonMailAddress	amazonMailAddress	必須 Amazonアカウントメールアドレス Amazonアカウントのメールアドレスを返却します。例：test@example.com
AmazonPhoneNumber	amazonPhoneNumber	必須 Amazonアカウント電話番号 Amazonアカウントの電話番号を返却します。例：03-0000-0002

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

※エラーコード、エラー詳細コード以外の値は全てShift-JISでURLエンコードした値を返却します。

レスポンスパラメータ：正常系

{
    "shippingCountryCode": "JP",
    "shippingPostalCode": "150-0043",
    "shippingStateOrRegion": "",
    "shippingAddressLine1": "%93%B9%8C%BA%8D%E2%203-14-6",
    "shippingAddressLine2": "%83q%83%85%81%5B%83%7D%83b%83N%83X%8Fa%92J%83r%83%8B",
    "shippingAddressLine3": "",
    "shippingName": "%83e%83X%83g%20%89%D4%8Eq",
    "shippingPhoneNumber": "03-0000-0001",
    "amazonAccountName": "%83e%83X%83g%20%91%BE%98Y",
    "amazonMailAddress": "test%40example.com",
    "amazonPhoneNumber": ""
}

レスポンスパラメータ：正常系


ShippingCountryCode=JP&ShippingPostalCode=150-0043&ShippingStateOrRegion=&ShippingAddressLine1=%93%B9%8C%BA%8D%E2%203-14-6&ShippingAddressLine2=%83q%83%85%81%5B%83%7D%83b%83N%83X%8Fa%92J%83r%83%8B&ShippingAddressLine3=&ShippingName=%83e%83X%83g%20%89%D4%8Eq&ShippingPhoneNumber=03-0000-0001&AmazonAccountName=%83e%83X%83g%20%91%BE%98Y&AmazonMailAddress=test%40example.com&AmazonPhoneNumber=

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PayType		必須半角数字2桁決済方法 38：Amazon Pay

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=38

レスポンス

正常

Status		必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証中 AUTH：仮売上 REQCAPTURE：即時売上受付 CAPTURE：即時売上 REQSALES：売上受付 SALES：実売上 CANCEL：キャンセル REQRETURN：返品受付 RETURN：返品 PAYFAIL：決済失敗
ProcessDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		必須処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返品
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
Amount		必須半角数字7桁利用金額
Tax		必須半角数字7桁税送料
ClientField1		必須全半角100バイト加盟店自由項目1
ClientField2		必須全半角100バイト加盟店自由項目2
ClientField3		必須全半角100バイト加盟店自由項目3
PayType		必須半角数字2桁決済方法 38：Amazon Pay
AmazonOrderReferenceID		必須半角英数19桁 AmazonオーダーリファレンスID Amazonの取引を特定するIDを返却します。
AmazonBillingAgreementID		必須半角英数19桁 AmazonビリングアグリーメントID ※随時決済の場合のみ値を返却します。 Amazonで随時取引を行うためのIDを返却します。
AmazonPayCancelAmount		必須半角数字7桁キャンセル金額キャンセル・返品した金額を返却します。
AmazonPayCancelTax		必須半角数字7桁キャンセル税送料金額キャンセル・返品した税送料を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=CAPTURE&ProcessDate=20190213200436&JobCd=CAPTURE&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&Amount=1000&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=38&AmazonOrderReferenceID=S03-6343111-8544339&AmazonBillingAgreementID=&AmazonPayCancelAmount=0&AmazonPayCancelTax=0

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

Amazon Pay

AmazonPay決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Content-Type: application/x-www-form-urlencoded;charset=windows-31j

POST

Content-Type: text/plain;charset=windows-31j

200：常に200を返却

Content-Type: application/json;charset=UTF-8

POST

Content-Type: application/json;charset=UTF-8

200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー ※以下のエラーコードはhttp200で返却される可能性がございます。 ・E90010001 ・E92000001 ・E92000002 ・E91099996 ・E91099997

EntryTranAmazonpay 取引登録

リクエスト

AmazonPay実装タイプ

レスポンス

正常

異常

ExecTranAmazonpay 決済実行

リクエスト

レスポンス

正常

現状態

処理日時

異常

AmazonpaySales 実売上

リクエスト

レスポンス

正常

現状態

異常

AmazonpayCancel キャンセル

リクエスト

キャンセル金額

キャンセル税送料

レスポンス

正常

現状態

キャンセル金額

キャンセル税送料

異常

SearchAddressAmazonpay 住所情報参照

リクエスト

レスポンス

正常

配送先国コード

配送先郵便番号

配送先都道府県

配送先住所1

配送先住所2

配送先住所3

配送先氏名

配送先電話番号

Amazonアカウント名

Amazonアカウントメールアドレス

Amazonアカウント電話番号

異常

SearchTradeMulti 取引状態参照

リクエスト

決済方法

レスポンス

正常

現状態

処理日時

決済方法

キャンセル金額

キャンセル税送料金額

異常